<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBustFactory</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<link rel="home" href="index.html" title="IBust Reference Manual">
<link rel="up" href="ch03.html" title="Input method engine">
<link rel="prev" href="ibust-IBustEngineSimple.html" title="IBustEngineSimple">
<link rel="next" href="IBustInputContext.html" title="IBustInputContext">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ibust-IBustEngineSimple.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">IBust Reference Manual</th>
<td><a accesskey="n" href="IBustInputContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IBustFactory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#IBustFactory.description" class="shortcut">Description</a>
                   | 
                  <a href="#IBustFactory.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#IBustFactory.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="IBustFactory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBustFactory.top_of_page"></a>IBustFactory</span></h2>
<p>IBustFactory — Factory for creating engine instances.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBustFactory.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="IBustFactory.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="IBustFactory.html#IBustFactory-struct" title="struct IBustFactory">IBustFactory</a>;
struct              <a class="link" href="IBustFactory.html#IBustFactoryClass" title="struct IBustFactoryClass">IBustFactoryClass</a>;
<span class="returnvalue">void</span>                <a class="link" href="IBustFactory.html#ibust-factory-add-engine" title="ibust_factory_add_engine ()">ibust_factory_add_engine</a>             (<em class="parameter"><code><a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a> *factory</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *engine_name</code></em>,
                                                         <em class="parameter"><code><span class="type">GType</span> engine_type</code></em>);
<a class="link" href="IBustEngine.html" title="IBustEngine"><span class="returnvalue">IBustEngine</span></a> *        <a class="link" href="IBustFactory.html#ibust-factory-create-engine" title="ibust_factory_create_engine ()">ibust_factory_create_engine</a>          (<em class="parameter"><code><a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a> *factory</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *engine_name</code></em>);
<a class="link" href="IBustFactory.html" title="IBustFactory"><span class="returnvalue">IBustFactory</span></a> *       <a class="link" href="IBustFactory.html#ibust-factory-new" title="ibust_factory_new ()">ibust_factory_new</a>                    (<em class="parameter"><code><span class="type">GDBusConnection</span> *connection</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="IBustFactory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="IBustObject.html" title="IBustObject">IBustObject</a>
               +----<a class="link" href="IBustService.html" title="IBustService">IBustService</a>
                     +----IBustFactory
</pre>
</div>
<div class="refsect1">
<a name="IBustFactory.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="IBustFactory.html#IBustFactory-create-engine" title='The "create-engine" signal'>create-engine</a>"                                  : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="IBustFactory.description"></a><h2>Description</h2>
<p>
An IBustFactory is an <a class="link" href="IBustService.html" title="IBustService"><span class="type">IBustService</span></a> that creates input method engine (IME) instance.
It provides CreateEngine remote method, which creates an IME instance by name,
and returns the D-Bus object path to IBust daemon.
</p>
<p>
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBustEngine.html" title="IBustEngine"><span class="type">IBustEngine</span></a>
</p>
</div>
<div class="refsect1">
<a name="IBustFactory.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="IBustFactory-struct"></a><h3>struct IBustFactory</h3>
<pre class="programlisting">struct IBustFactory;</pre>
<p>
An opaque data type representing an IBustFactory.
</p>
</div>
<hr>
<div class="refsect2">
<a name="IBustFactoryClass"></a><h3>struct IBustFactoryClass</h3>
<pre class="programlisting">struct IBustFactoryClass {
    /* signals */
    IBustEngine *
                (* create_engine)
                                    (IBustFactory    *factory,
                                     const gchar    *engine_name);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ibust-factory-add-engine"></a><h3>ibust_factory_add_engine ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ibust_factory_add_engine             (<em class="parameter"><code><a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a> *factory</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *engine_name</code></em>,
                                                         <em class="parameter"><code><span class="type">GType</span> engine_type</code></em>);</pre>
<p>
Add an engine to the factory.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>An IBustFactory.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine_name</code></em> :</span></p></td>
<td>Name of an engine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine_type</code></em> :</span></p></td>
<td>GType of an engine.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-factory-create-engine"></a><h3>ibust_factory_create_engine ()</h3>
<pre class="programlisting"><a class="link" href="IBustEngine.html" title="IBustEngine"><span class="returnvalue">IBustEngine</span></a> *        ibust_factory_create_engine          (<em class="parameter"><code><a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a> *factory</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *engine_name</code></em>);</pre>
<p>
Create an <a class="link" href="IBustEngine.html" title="IBustEngine"><span class="type">IBustEngine</span></a> with <em class="parameter"><code>engine_name</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>An <a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine_name</code></em> :</span></p></td>
<td>Name of an engine.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="IBustEngine.html" title="IBustEngine"><span class="type">IBustEngine</span></a> with <em class="parameter"><code>engine_name</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ibust-factory-new"></a><h3>ibust_factory_new ()</h3>
<pre class="programlisting"><a class="link" href="IBustFactory.html" title="IBustFactory"><span class="returnvalue">IBustFactory</span></a> *       ibust_factory_new                    (<em class="parameter"><code><span class="type">GDBusConnection</span> *connection</code></em>);</pre>
<p>
New an IBustFactory.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>An GDBusConnection.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated IBustFactory.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="IBustFactory.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="IBustFactory-create-engine"></a><h3>The <code class="literal">"create-engine"</code> signal</h3>
<pre class="programlisting"><a class="link" href="IBustEngine.html" title="IBustEngine"><span class="returnvalue">IBustEngine</span></a>*         user_function                      (<a class="link" href="IBustFactory.html" title="IBustFactory"><span class="type">IBustFactory</span></a> *factory,
                                                        <span class="type">gchar</span>       *engine_name,
                                                        <span class="type">gpointer</span>     user_data)        : <code class="literal">Run Last</code></pre>
<p>
The ::create-engine signal is a signal to create IBustEngine
with <em class="parameter"><code>engine_name</code></em>, which gets emitted when IBustFactory
received CreateEngine dbus method. The callback functions
will be called until a callback returns a non-null object
of IBustEngine.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>the factory which received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine_name</code></em> :</span></p></td>
<td>the engine_name which received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td>An IBustEngine. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>